home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / bbs / bull211.lha / bulletin.doc < prev   
Text File  |  1994-08-03  |  5KB  |  130 lines
  1.                  Citadel bulletin Program
  2.                    Version 2.11
  3.                  Copyrighted 1992-94 Custom Services
  4.                  ***All Rights Reserved***
  5.  
  6.  
  7. Introduction:
  8.  
  9.    Citadel has long lacked an ability to display bulletins.  To correct
  10.    for this, I created Bulletin.  This program will read a directory
  11.    and display all the files of the name *.hlp as bulletins.  It also
  12.    has the ability to scan sub-directories and display the items in the
  13.    directory as a menu if that item is selected.  There is no limit to
  14.    the number of items or levels available, but for practical usage it
  15.    makes sense to limit a directory to 15-20 items.  While this door is
  16.    made for the Citadel BBS program, it may be used with any BBS program
  17.    that supports STDIO doors.
  18.  
  19. Format:
  20.  
  21.    Each text file is opened and the first line is read and used as the
  22.    menu description.  This makes up the menu.  In each directory there
  23.    is a file called header.dir, this is the description of the contents
  24.    and is displayed the same as an item when you select the item which
  25.    is a directory.  You should have one in the top level bulletin
  26.    directory.  the basic structure looks like this:
  27.  
  28.  
  29.              [bulletin directory]
  30.                       |
  31.       +---------------+---------+
  32.       |                         |
  33.   [ directory]             [ *.hlp ]              Level 0
  34.        |
  35.   +----+-------+-------------------+
  36.   |            |                   |
  37.   header.dir  [other directores]  [ *.hlp]        Level 1
  38.  
  39.   The files (*.hlp) at level 0 would be displayed along with each
  40.   directory.  The first line is displayed.  If the directory is selected
  41.   the header.dir file is displayed, then the *.hlp files make up the
  42.   menu(along with other directories).  This allows you to organize by
  43.   subjects(door games for example).
  44.  
  45.   The rest of the files(*.hlp, header.dir) are just plain text to display
  46.   when the item is selected.  This program is compatible with the news
  47.   files of the space empire and Nuclear Warfare doors for example.  If
  48.   you direct your door news files(or create a link is running 2.0), you
  49.   can have the bulletins display them for users.   Note, registration of
  50.   this door will remove the reminder that displays at the beginning of
  51.   each level.
  52.  
  53. Requirements:
  54.  
  55.   You must be running the Citadel 3.42.E13 or later to have an autodoor
  56.   directed toward the user Citadel.  You must also have CTDLAUX: mounted
  57.   and the configuration data setup for the door and event as follows:
  58.  
  59.  
  60.    #door Bull bull  bbs:bbs/bulletins  anyone  modem unlimited
  61.    Bulletins for Users.
  62.    <ctdlaux: >ctdlaux:  bbs:bbs/bulletins
  63.  
  64.    #door Bxll bulletin  bbs:bbs/bulletins  autodoor  modem unlimited
  65.    Bulletins for Users.
  66.    <ctdlaux: >ctdlaux:  bbs:bbs/bulletins
  67.  
  68.    #event All 0:00 autodoor quiet 1440 "Bulletins" "Citadel" Bxll
  69.  
  70.    This creates two door entries, one the users can use at anytime with
  71.    the command ".D Bull".  The other door entry is an autodoor for every
  72.    user.  The Event(required for an autodoor) says that the bulletins
  73.    door is available every day, all day(1440 minutes == 24 hours).
  74.    You may taylor these entries as you desire.
  75.  
  76.    This door also uses two environment variables for registering.  If you
  77.    have not registered this program yet, then do not worry about them since
  78.    the program will give an error if they exist and are incorrect.
  79.  
  80.    Variable             Usage
  81.    BULL_REGISTRATION    This is the registration key.
  82.    BULL_BBS_NAME        This is the BBS name the door is registered too.
  83.  
  84.    Do not create them until you have registered.  If they exist and are
  85.    incorrect(the BBS_NAME is case sensitive), the bbs will delay and report
  86.    an error to the user.  Once you have registered your BBS, you can create
  87.    them with:
  88.  
  89.    SETENV BULL_BBS_NAME      "The Amiga Zone"
  90.    SETENV BULL_REGISTRATION  <the key I give you>
  91.  
  92.    SETENV does not save the values permanently.  You will have to have
  93.    these statements in your USER_STARTUP(or STARTUP-SEQUENCE if under 1.3).
  94.  
  95. CLI Usage:
  96.  
  97.    This door may be run from the cli.  If you put it on your path, then
  98.    you could run the door the same as the users from you cli shell window
  99.    with:
  100.  
  101.    bulletin <directory>
  102.  
  103.    <directory> is the top level directory which contains the bulletins.
  104.    it may be any place on you disk drives.
  105.  
  106. Shareware:
  107.  
  108.    This door is a shareware product.  The registration fee is only $10.
  109.    You may use this program for up to 30 days.  Beyond that time, you
  110.    should feel really guilty that you have not paid the fee.
  111.  
  112.    Registration will get you a key for your BBS.  When you register, please
  113.    include the BBS name, name of the program your registering, and the
  114.    $10 fee.  The Key will remove the reminder.
  115.  
  116.    Send your registration fee, or if you decide not to register a
  117.    comment or two as to why(and what improvements to make) to:
  118.  
  119.    Custom Services
  120.    P. O. Box 254
  121.    Moorestown, NJ 08057
  122.  
  123. Bugs:
  124.  
  125.    There are no know bugs in this program.  If you have a problem with
  126.    this door, contact me via the Citadel 68K or Amiga rooms on your
  127.    nearest Citadel.  You can always call the Amiga Zone at (609) 953-8159
  128.    and leave comments.
  129.  
  130.